org.springframework.web.client

Class ExtractingResponseErrorHandler

java.lang.Object

org.springframework.web.client.DefaultResponseErrorHandler

org.springframework.web.client.ExtractingResponseErrorHandler

All Implemented Interfaces:

ResponseErrorHandler

public class ExtractingResponseErrorHandler
extends DefaultResponseErrorHandler

Implementation of ResponseErrorHandler that uses HttpMessageConverters to convert HTTP error responses to RestClientException.

To use this error handler, you must specify a status mapping and/or a series mapping. If either of these mappings has a match for the status code of a given ClientHttpResponse, DefaultResponseErrorHandler.hasError(ClientHttpResponse) will return true and DefaultResponseErrorHandler.handleError(ClientHttpResponse) will attempt to use the configured message converters to convert the response into the mapped subclass of RestClientException. Note that the status mapping takes precedence over series mapping.

If there is no match, this error handler will default to the behavior of DefaultResponseErrorHandler. Note that you can override this default behavior by specifying a series mapping from HttpStatus.Series#CLIENT_ERROR and/or HttpStatus.Series#SERVER_ERROR to null.

Since:

5.0

Author:

Simon Galperin, Arjen Poutsma

See Also:

RestTemplate.setErrorHandler(ResponseErrorHandler)

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<HttpMessageConverter<?>>	messageConverters
private java.util.Map<HttpStatus.Series,java.lang.Class<? extends RestClientException>>	seriesMapping
private java.util.Map<HttpStatus,java.lang.Class<? extends RestClientException>>	statusMapping

Constructor Summary

Constructors

Constructor and Description
ExtractingResponseErrorHandler() Create a new, empty ExtractingResponseErrorHandler.
ExtractingResponseErrorHandler(java.util.List<HttpMessageConverter<?>> messageConverters) Create a new ExtractingResponseErrorHandler with the given HttpMessageConverter instances.

Method Summary

Modifier and Type	Method and Description
private void	extract(java.lang.Class<? extends RestClientException> exceptionClass, ClientHttpResponse response)
void	handleError(ClientHttpResponse response, HttpStatus statusCode) Handle the error in the given response with the given resolved status code.
protected boolean	hasError(HttpStatus statusCode) Template method called from DefaultResponseErrorHandler.hasError(ClientHttpResponse).
void	setMessageConverters(java.util.List<HttpMessageConverter<?>> messageConverters) Set the message converters to use by this extractor.
void	setSeriesMapping(java.util.Map<HttpStatus.Series,java.lang.Class<? extends RestClientException>> seriesMapping) Set the mapping from HTTP status series to RestClientException subclass.
void	setStatusMapping(java.util.Map<HttpStatus,java.lang.Class<? extends RestClientException>> statusMapping) Set the mapping from HTTP status code to RestClientException subclass.

Methods inherited from class org.springframework.web.client.DefaultResponseErrorHandler

getCharset, getHttpStatusCode, getResponseBody, handleError, hasError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.web.client.ResponseErrorHandler

handleError

Field Detail

messageConverters

private java.util.List<HttpMessageConverter<?>> messageConverters

statusMapping

private final java.util.Map<HttpStatus,java.lang.Class<? extends RestClientException>> statusMapping

seriesMapping

private final java.util.Map<HttpStatus.Series,java.lang.Class<? extends RestClientException>> seriesMapping

Constructor Detail

ExtractingResponseErrorHandler

public ExtractingResponseErrorHandler()

Create a new, empty ExtractingResponseErrorHandler.

Note that setMessageConverters(List) must be called when using this constructor.

ExtractingResponseErrorHandler

public ExtractingResponseErrorHandler(java.util.List<HttpMessageConverter<?>> messageConverters)

Create a new ExtractingResponseErrorHandler with the given HttpMessageConverter instances.

Parameters:

messageConverters - the message converters to use

Method Detail

setMessageConverters

public void setMessageConverters(java.util.List<HttpMessageConverter<?>> messageConverters)

Set the message converters to use by this extractor.

setStatusMapping

public void setStatusMapping(java.util.Map<HttpStatus,java.lang.Class<? extends RestClientException>> statusMapping)

Set the mapping from HTTP status code to RestClientException subclass. If this mapping has a match for the status code of a given ClientHttpResponse, DefaultResponseErrorHandler.hasError(ClientHttpResponse) will return true and DefaultResponseErrorHandler.handleError(ClientHttpResponse) will attempt to use the configured message converters to convert the response into the mapped subclass of RestClientException.

setSeriesMapping

public void setSeriesMapping(java.util.Map<HttpStatus.Series,java.lang.Class<? extends RestClientException>> seriesMapping)

Set the mapping from HTTP status series to RestClientException subclass. If this mapping has a match for the status code of a given ClientHttpResponse, DefaultResponseErrorHandler.hasError(ClientHttpResponse) will return true and DefaultResponseErrorHandler.handleError(ClientHttpResponse) will attempt to use the configured message converters to convert the response into the mapped subclass of RestClientException.

hasError

protected boolean hasError(HttpStatus statusCode)

Description copied from class: DefaultResponseErrorHandler

Template method called from DefaultResponseErrorHandler.hasError(ClientHttpResponse).

The default implementation checks if the given status code is CLIENT_ERROR or SERVER_ERROR. Can be overridden in subclasses.

Overrides:

hasError in class DefaultResponseErrorHandler

Parameters:

statusCode - the HTTP status code

Returns:

true if the response has an error; false otherwise

handleError

public void handleError(ClientHttpResponse response,
                        HttpStatus statusCode)
                 throws java.io.IOException

Description copied from class: DefaultResponseErrorHandler

Handle the error in the given response with the given resolved status code.

This default implementation throws a HttpClientErrorException if the response status code is HttpStatus.Series.CLIENT_ERROR, a HttpServerErrorException if it is HttpStatus.Series.SERVER_ERROR, and a RestClientException in other cases.

Overrides:

handleError in class DefaultResponseErrorHandler

Throws:

java.io.IOException

extract

private void extract(@Nullable
                     java.lang.Class<? extends RestClientException> exceptionClass,
                     ClientHttpResponse response)
              throws java.io.IOException

Throws:

java.io.IOException